home *** CD-ROM | disk | FTP | other *** search
/ PC-SIG Library 8 / PC-SIG Library CD-ROM (8th Edition) (1990-04).iso / 1301_400 / disk1332 / readme < prev    next >
Encoding:
Text File  |  1989-08-21  |  8.4 KB  |  223 lines
  1.                                HyperHelper 1.5a
  2.  
  3.                           Another ShareWare Product:
  4.                    Inexpensive software for the rest of us!
  5.                                      by
  6.                                 Bryan Flamig
  7.  
  8.  
  9.     HyperHelper is a ShareWare utility that enables you to construct
  10.     custom hypertext help and readme systems.
  11.  
  12.     Files you should have:
  13.     
  14.         readme       -- This file.
  15.         hh.exe       -- The hypertext browser.
  16.         hc.exe       -- The hypertext compiler.
  17.         hyperhlp.htx -- A sample hypertext file that briefly explains
  18.                         what HyperHelper is and how to use it.
  19.         sample.txt   -- A sample text file that illustrates how
  20.                         hypertext cards are created in HyperHelper.
  21.  
  22.     
  23.     A Brief Description
  24.  
  25.     HyperHelper is a ShareWare utility that is ideal for creating
  26.     custom hypertext help and readme systems on IBM PC's and
  27.     compatibles. HyperHelper differs from other help utilities
  28.     in that it is simple, inexpensive, and takes a minimum of
  29.     resources, yet at the same time provides a way to incorporate
  30.     hypertext into help systems.
  31.  
  32.     You can use HyperHelper to build your own:
  33.  
  34.              o hypertext "readme" files
  35.              o hypertext help for application programs
  36.              o hypertext help for programming libraries
  37.          o hypertext references for just about anything!
  38.  
  39.     HyperHelper consists of a hypertext compiler and browser which
  40.     enable you to create and view hypertext files. A hypertext help
  41.     system begins as a text file that contains the information that
  42.     is to be displayed by the browser. In addition, special link
  43.     commands are embedded into this text which specify how you will
  44.     be able to move about the information. The compiler then reads
  45.     this file and translates it into a special hypertext format that
  46.     you can view with the browser. That's all there is to it!
  47.  
  48.  
  49.     Getting Started
  50.     
  51.     If you want to begin learning how HyperHelper works, try running
  52.     the hypertext browser by typing:
  53.     
  54.                               hh hyperhlp
  55.     
  56.     at the DOS prompt. This will invoke the HyperHelper browser and
  57.     display the contents of the hyperhlp.htx file-- a hypertext
  58.     file which explains how to use HyperHelper and briefly tells you
  59.     how you can go about building your own hypertext cards.
  60.     
  61.     
  62.     Try Out the HyperHelper Compiler
  63.     
  64.     After you get a feel for the HyperHelper browser, you'll probably
  65.     want to try out the HyperHelper compiler. For your convenience
  66.     the distribution disk includes a very simple hypertext file,
  67.     called sample.txt, that you can try compiling. You can edit this
  68.     file with your favorite text editor; however, make sure your editor
  69.     has formatting turned off.
  70.     
  71.     To compile sample.txt into a hypertext file that is readable by the
  72.     HyperHelper browser use:
  73.     
  74.                               hc sample
  75.     
  76.     Note that the .txt extension of the filename is not used. The
  77.     compiler will translate the .txt file into a special format that
  78.     is only readable by the HyperHelper browser. This compiled file
  79.     will be called sample.htx.
  80.     
  81.     Now try browsing through the file sample.htx with the HyperHelper
  82.     browser by typing:
  83.     
  84.                               hh sample
  85.     
  86.     You'll probably want to look at sample.txt to see how the various
  87.     HyperHelper commands are used. In addition, you might want to try
  88.     modifying the file in order to try out the commands on your own.
  89.     
  90.     
  91.     Tips on Using HyperHelper
  92.     
  93.     Although space does not allow a full description of the features in
  94.     HyperHelper, the following tips may prove useful while you are
  95.     learning how to use HyperHelper:
  96.     
  97.     1. If you encounter problems reading the screen with your monochrome
  98.        monitor, try the following option which forces HyperHelper to
  99.        use monochrome attributes:
  100.                 
  101.                             hh -m <hypertext_file>
  102.     
  103.     2. You can move the HyperHelper window on the screen by holding
  104.        down the Shift key while using the arrow keys. If snow appears
  105.        on the screen when moving the window, try invoking HyperHelper
  106.        with the -s switch at the command-line. This will prevent most
  107.        of the snow. Therefore, if snow appears on the screen use:
  108.     
  109.                             hh -s <hypertext_file>
  110.     
  111.     3. HyperHelper is designed to work in text mode only.
  112.  
  113.     4. For best performance locate your hypertext files on a hard disk.
  114.        
  115.       
  116.     A Word of Caution
  117.     
  118.     This version of HyperHelper is fully operational, but it DOES NOT
  119.     contain a comprehensive user's guide. Nonetheless, the files
  120.     sample.txt and hyperhlp.htx should give you an adequate idea of
  121.     how HyperHelper works and how to make your own hypertext system.
  122.     If you find HyperHelper useful and decide to register your copy
  123.     of HyperHelper, you will receive the complete printed documentation.
  124.  
  125.  
  126.     HyperHelper 1.5a Updates
  127.  
  128.     Here are the updates since Version 1.1a:
  129.  
  130.      1) Fixed numerous bugs
  131.      2) Added ability to switch files while in browser
  132.      3) Added automatic file compression
  133.      4) Added a keyword search command to the browser
  134.      5) Even with all these new additions, the .exe files 
  135.         are actually smaller!
  136.    
  137.     The Version 1.5 browser will still work with .htx files
  138.     compiled with older versions, however, you should re-compile
  139.     them to get the benefits of file compression.
  140.  
  141.     See the hyperhlp.htx tutorial for more information about the
  142.     above changes.
  143.  
  144.  
  145.     No Royalties!
  146.  
  147.     The best thing about HyperHelper is that no royalties are 
  148.     charged for using the HyperHelper browser with any decks
  149.     you might distribute. This is in contrast to many of the
  150.     other hypertext authoring systems that charge you royalties.
  151.     All we ask is that if you use the compiler to build hypertext
  152.     decks, then you must register your copy of HyperHelper. The 
  153.     browser can be used freely as long as it is not distributed
  154.     for a fee! 
  155.     
  156.  
  157.     Registering HyperHelper!
  158.     
  159.     Since HyperHelper is a ShareWare product, you are encouraged to
  160.     experiment with it and share it with your friends as long as the
  161.     following provisions are met:
  162.     
  163.        1) It is distributed ONLY in its original, unmodified form.
  164.        2) No fee is charged for copying or distribution without
  165.           permission by the author.
  166.     
  167.     If you find HyperHelper useful, you should register your copy 
  168.     for $20, in which case you will receive:
  169.     
  170.        1) The latest version of HyperHelper.
  171.        2) A printed user's guide that explains how to use the
  172.           HyperHelper browser and how to create your own
  173.           hypertext files.
  174.        3) A memory-resident, context sensitive version of the
  175.           HyperHelper browser.
  176.        4) An install program which allows you to change the
  177.           colors used by HyperHelper.
  178.     
  179.     To register HyperHelper, fill out the form below and send it along
  180.     with $20 in check, money order, or Visa/MasterCard. Or for
  181.     immediate processing, call the number below and place your order
  182.     using your Visa or MasterCard.
  183.  
  184.  
  185.                           Ein Stein's Computers,
  186.                           750 Bridge Street
  187.                           Yuba City, CA  95991
  188.                           (916) 671-7444
  189.  
  190.  
  191.     __________________________________________________________________
  192.     Name
  193.  
  194.     __________________________________________________________________
  195.     Company Name
  196.  
  197.     __________________________________________________________________
  198.     Address
  199.  
  200.     __________________________________________________________________
  201.     City                         State                 Zip
  202.  
  203.     __________________________________________________________________
  204.     Telephone
  205.  
  206.  
  207.     Registration Fee:  $ _____________
  208.  
  209.     Tax (CA only)   :  $ _____________
  210.  
  211.     Total Enclosed  :  $ _____________
  212.  
  213.  
  214.     Method of payment:  Check ______   Visa ______   MasterCard ______
  215.  
  216.     Credit Card Number: ______________________________________________
  217.  
  218.     Expiration Date: _________________________________________________
  219.  
  220.     Signature:________________________________________________________
  221.  
  222.     [152]
  223.